home *** CD-ROM | disk | FTP | other *** search
/ WAVs MIDIs & RealAudio / WAVs MIDIs & RealAudio.iso / mac / StreamWorks™ 2.0.4 / Documentation next >
Encoding:
Text File  |  1996-07-26  |  12.9 KB  |  231 lines  |  [TEXT/ttxt]

  1. StreamWorks™ 2.0.1
  2. ©1996 Xing Technology, Inc. 
  3.  
  4. http://www.xingtech.com/
  5.  
  6. Contents
  7.  
  8. -  Introducing the StreamWorks Player
  9. -  Playing Streams
  10. -  Displaying Information about a Stream
  11. -  Controlling the Video Display Window
  12. -  Controlling Audio Playback
  13. -  Setting Network Options
  14. -  Configuring as a Helper Application
  15. -  Diagnostics
  16. -  Contacting us
  17.  
  18. Introducing the StreamWorks™ Player
  19.  
  20. The StreamWorks Player is an application for receiving video/audio streams delivered by StreamWorks Servers and StreamWorks 
  21. Transmitters. The StreamWorks Player features:
  22. -  VCR-style controls for controlling playback;
  23. -  flexible methods for opening streams;
  24. -  diagnostic tools.
  25.  
  26. The StreamWorks Player currently supports a number of computer platforms and is available in the following form:
  27. -  Helper Application - This version of the StreamWorks Player operates as a stand-alone application and as a Helper
  28.    Application to web browsers.
  29.  
  30. Consult Xing's Web site (www.xingtech.com) for the current availability on the supported platforms and for general 
  31. information about StreamWorks, the StreamWorks Player's relationship to other StreamWorks components, and the 
  32. types of streams available.
  33.  
  34.  
  35. Playing Streams
  36. Starting the StreamWorks Player
  37.  
  38. As with most applications, you can start the StreamWorks Player in a number of ways:
  39. On the Macintosh - Open the StreamWorks Player program by double-clicking on the "StreamWorks™ 2.0.1" 
  40. icon, or double click one of its files. 
  41.  
  42. Opening and Closing Streams
  43.  
  44. When the StreamWorks Player is registered as a helper application, it automatically opens a stream any time you click on a 
  45. Hypertext reference to a file with the ".xdm" filename extension. An XDM file contains a stream specification that resembles 
  46. a standard URL used by WEB Browsers; URL-style stream specifications are in the form:
  47.  
  48. XDMA://{swServer}:{swPort}/{Stream}
  49.  
  50. Where:
  51. -  "XDMA" specifies the StreamWorks protocol;
  52. -  {swServer} is the IPaddress of a StreamWorks Server;
  53. -  {swPort} is the Port to which the StreamWorks Server listens for stream requests; by default, this Port is "1558" and 
  54.     can usually be excluded from the URL.
  55. -  {Stream} is the name of a PLAY file or an on-demand audio/video file residing on the StreamWorks Server.
  56.     For example:
  57.     XDMA://111.222.111.222:1558/grammy.mpg
  58.  
  59. Opening Streams With Menu Commands
  60.  
  61. After starting the StreamWorks Player, you can use menu commands to open a stream:
  62. -  Choose "Open Stream" from the File menu. A dialog appears and asks you to enter a stream specification.
  63. -  Enter a URL-style stream specification and click "Ok".
  64.  
  65. Opening Streams With Command Line Parameters
  66.  
  67. You can cause the StreamWorks Player to automatically open a stream by passing it the pathname of a local XDM file as 
  68. a command line parameter.
  69.  
  70.  
  71. Starting and Stopping Playback
  72.  
  73. After opening a stream, use the following techniques to control playback:
  74. -  To begin playback, click the Play button.
  75. -  To stop playback, click the  Stop button.
  76.  
  77. NOTE: When you stop and re-start playback, the StreamWorks Player first closes its connection to the current StreamWorks 
  78. Server and then must establish a new connection to the StreamWorks Server. If the StreamWorks Server becomes busy 
  79. while playback is stopped, the attempt to establish a new connection may be refused, and you will receive an error 
  80. "Stream Busy".
  81.  
  82. Navigating a Stream
  83.  
  84. To change the current position within a stream that has been opened in the StreamWorks Player, drag the Slider across 
  85. the Track Bar to the desired position. When you use this technique, the Current Position Indicator displays the new position.
  86.  
  87. NOTE: The navigation controls are available only when the current stream is an On-Demand File.
  88.  
  89. Closing a Stream
  90.  
  91. To close a stream that is opened in the StreamWorks Player, use one of the following techniques:
  92. -  Choose Close from the File menu.
  93. -  Open another stream; the previously opened stream is automatically closed.
  94. -  Exit the StreamWorks Player.
  95.  
  96.  
  97. Displaying Information about a Stream
  98.  
  99. To display information about a stream that has been opened in the StreamWorks Player, use one of the following techniques:
  100. -  Choose Stream Info? from the File menu.
  101. -  Click the Info button.
  102.  
  103. The Information Window appears and displays the following information about the opened stream:
  104. -  Server Name - the "Domain Name" or IP address of the StreamWorks server from which the stream originates.
  105. -  Stream Name - the name of the current stream.
  106. -  Stream Length - the total duration of the stream expressed in HH:MM:SS. This field is active only when the current 
  107.     stream is an On-Demand File.
  108. -  Total Data Rate - the total amount of data in the stream measured in kilobits/second.
  109. -  Video Data Rate - the amount of video data in the stream measured in kilobits/second.
  110. -  Video Width - the horizontal size of video frames in the stream measured in pixels.
  111. -  Video Height - the vertical size of video frames in the stream measured in pixels.
  112. -  Total Audio Rate - the amount of audio data in the stream measured in kilobits/second.
  113. -  Audio Sample Rate - the sample rate of audio data in the stream;
  114. -  Audio Channels - the number of channels in the stream's audio data; valid values are Mono, Stereo, Joint Stereo, 
  115.    and Dual Channel.
  116. -  Audio Format - the format of audio data in the stream; valid values are MPEG1, MPEG2, and LBR.
  117.  
  118.  
  119. Controlling the Video Display Window
  120.  
  121. When you open a stream that contains video data, the Video Display Window appears and displays the stream's 
  122. first video frame. Read the following topics for instructions for controlling the Video Display window.
  123.  
  124. Stretching the Video Display Window
  125. To resize the Video Display Window by stretching the Window, use standard techniques for resizing the window frame. 
  126.  
  127. Closing the Video Display Window
  128. Closing the Video Display window hides the video window.
  129.  
  130. Controlling Audio Playback
  131. When you play a stream that contains audio data, the StreamWorks Player plays the audio through your computer's 
  132. Sound System and provides controls for muting audio playback and adjusting audio playback volume. 
  133.  
  134. Adjusting Audio Playback Volume
  135.  
  136. To adjust the audio playback volume, click the Audio button, and select the desired volume level.
  137.  
  138. Controlling Audio Quality
  139.  
  140. To control audio playback quality, use the following items in the Settings menu:
  141. -  Playback -> Mono - Forces Monaural Audio Playback.
  142. -  Playback -> Stereo - Enables Stereo Audio Playback.
  143. -  Playback -> Optimize Audio - Causes the StreamWorks Player to optimize audio quality.
  144. -  Playback -> Mixed - Causes the StreamWorks Player to balance resource allocation between audio and video playback.
  145. -  Playback -> Optimize Video - Causes the StreamWorks Player to reduce audio quality, so processing time can be allocated 
  146.    to video playback.
  147.  
  148. The characteristics of the audio data generated by the StreamWorks Player can affect your computer's overall playback 
  149. performance; e.g., stereo audio contains twice as much data as monaural audio. Depending on the nature of your computer's 
  150. sound system, the overhead processing associated with transferring this additional data to your computer's sound board 
  151. may adversely affect overall playback performance.
  152.  
  153.  
  154. Setting Network Options
  155.  
  156. To insure proper interaction with other StreamWorks components, you must specify your computer's network connection 
  157. speed and relationship to network firewalls.
  158.  
  159. Specifying a Connection Speed
  160.  
  161. When the StreamWorks Player sends to a StreamWorks Server a stream request, the request includes data indicating the 
  162. StreamWorks Player's network connection speed. To insure proper delivery of streams, you must specify your computer's 
  163. connection speed by choosing an item from the StreamWorks Player's Settings menu:
  164.  
  165. -  9600 Modem - indicates that your computer's connection speed is 9.6kbs;
  166. -  14.4 Modem - indicates that your computer's connection speed is 14.4kbs;
  167. -  28.8 Modem - indicates that your computer's connection speed is 28.8kbs;
  168. -  56K (1B ISDN) - indicates that your computer's connection speed is 56kbs;
  169. -  128K (2B ISDN) - indicates that your computer's connection speed is 128kbs;
  170. -  1.5M (T1) - indicates that your computer's connection speed is 1500kbs;
  171. -  Other - opens a dialog in which you enter your computer's connection speed.
  172.  
  173. Specifying a Firewall Proxy
  174.  
  175. A firewall is a device (usually a computer) that prevents direct network communications between a Local Area Network 
  176. (e.g., a LAN in a corporate office) and the Internet. Any network communications between the LAN and the Internet 
  177. must be permitted by "punching holes" in the firewall or running "proxies" on the firewall.
  178.  
  179. StreamWorks streams may be accessed through firewalls via one of two methods - either the network administrator needs 
  180. to "punch a hole" in the existing firewall for incoming and outgoing UDP traffic on port 1558 (this is Xing's InterNIC 
  181. registered port), or your administrator can run an appropriate proxy.
  182.  
  183. If your administrator chooses to run a firewall proxy, you must configure the StreamWorks Player to use this proxy 
  184. when contacting StreamWorks Servers:
  185. -  Start the StreamWorks Player
  186. -  Choose Network… from the Settings menu.
  187. -  Complete the Firewall proxy fields as instructed by your network administrator.
  188.  
  189. Configuring as a Helper Application
  190. You will need to set up StreamWorks' mime-type with your web browser in order
  191. to use it to launch StreamWorks streams.  When quoted text is given, do not enter the quotes.
  192.  
  193. Netscape users: 
  194. Go to the Options Menu and select General Preferences.  Choose the "Helpers" tab, and click on the "New" button.  
  195. In the mime-type field, type in "application/x-xdma".  In the mime-subtype field, type in "xdma" 
  196. without the quotes (all lower case).  Click on OK.  In the extentions field, type in "xdm, xdma" without the quotes.  
  197. Click the radio button under "Action" click "Launch Application", click the Browse button, and find your 
  198. StreamWorks player.
  199.  
  200. Internet Explorer Users:
  201. Go to the Edit Menu and select Options.  Select the "Helpers" tab.  Click Add.  Type "StreamWorks Stream" in the 
  202. Description field, Type "application/x-xdma" in the mime-type field, and "xdm, xdma" in the Suffixes field.  Click the 
  203. Choose button next to Helper Application, and find the StreamWorks player icon.  Type "XDMA" in the File Type 
  204. field.  Click the "Add" button.
  205.  
  206.  
  207. Diagnostics
  208.  
  209. The StreamWorks Player's Diagnostics window displays various real-time statistics regarding stream reception.
  210.  
  211. Contacting us
  212.  
  213. Xing Technology 
  214. 1540 West Branch Street
  215. Arroyo Grande, CA, 93420
  216. Phone 805/473-0145 
  217.  
  218. http://www.xingtech.com/
  219.  
  220. Limited Warranty
  221. from XING TECHNOLOGY CORPORATION
  222.  
  223. Xing Technology Corporation ("Xing") warrants the accompanying software and its accompanying materials, if any (collectively, the "Product") for a period of ninety (90) days from the date of receipt as follows: 1) the software will perform substantially in accordance with its accompanying written or electronic documentation and materials; 2) the materials accompanying the software, if any, will be substantially free from defects.  Any implied warranties allowed by local law are limited to ninety (90) days from the date of receipt.
  224.  
  225. Xing's entire liability and your exclusive remedy shall be: A) If the Product was purchased for a fee or included in a bundle or package purchased for a fee, at Xing's option either 1) refund of the price paid for the Product if purchased alone or the fair market value of the Product if purchased as part of a bundle or package, or 2) repair or replacement of the Product, if the Product is returned to Xing with a copy of your receipt; B) If the Product was distributed for free, replacement with a similar free Product, but ONLY if Xing is then distributing similar Products for free at the time the warranty claim is made, and if you pay the costs of making such replacement.  Any replacement Product will be warranted for the remainder of the original warranty period or ninety (90) days, whichever is longer.
  226.  
  227. THE PRODUCT IS PROVIDED WITHOUT, AND XING DISCLAIMS, ANY OTHER EXPRESS OR IMPLIED WARRANTIES, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  THIS LIMITED WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS.  YOU MAY HAVE OTHERS, WHICH VARY FROM STATE/JURISDICTION TO STATE/JURISDICTION.
  228.  
  229. XING SHALL NOT BE LIABLE: (A) FOR INCIDENTAL, CONSEQUENTIAL, SPECIAL, OR INDIRECT DAMAGES OF ANY SORT WHATSOEVER, WHETHER ARISING IN TORT, CONTRACT, OR OTHERWISE (INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS, REVENUES, OR INFORMATION, OR FOR BUSINESS INTERRUPTION) RESULTING FROM YOUR USE OF THE PRODUCT OR YOUR INABILITY TO USE THE PRODUCT, EVEN IF XING HAS BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES; OR (B) FOR ANY CLAIM BY ANY PARTY OTHER THAN YOU. IN NO EVENT SHALL XING'S LIABILITY TO YOU EXCEED THE AMOUNT YOU ORIGINALLY PAID FOR THE PRODUCT.  THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION.  SOME STATES AND JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE LIMITATION AND EXCLUSION MAY NOT APPLY TO YOU.
  230.  
  231.